FindDataString Method, SftTreeItems Object


	SftTreeItems.FindDataString Method	Softel vdm, Inc.

Searches the DataString property of items.

Syntax

		VB.NET	FoundIndex = object.FindDataString(ByVal ItemIndex As Integer, ByVal ItemDataString As String) As Integer
		VB	FoundIndex = object.FindDataString(ByVal ItemIndex As Long, ByVal ItemDataString As String) As Long
		C#.NET	int FoundIndex = object.FindDataString(int ItemIndex, string ItemDataString);
		VC++	long FoundIndex = object->FindDataString(long ItemIndex, _bstr_t ItemDataString);
		C	HRESULT object->raw_FindDataString(long ItemIndex, BSTR ItemDataString, long* FoundIndex);
		Delphi	FoundIndex := object.FindDataString(ItemIndex : Integer; ItemDataString : WideString) : Integer;

object

A SftTreeItems object.

ItemIndex

The zero-based index of the item where the search begins (including ItemIndex).

ItemDataString

The value to be searched.

FoundIndex

Returns the index of the item whose Item.DataString property has the value specified by ItemDataString. -1 is returned if no matching item is found.

Comments

The FindDataString method searches the Item.DataString property of items.

The value described by ItemDataString is compared to the Item.DataString property of all items involved in the search. The search starts at the item described by ItemIndex. If an item with a matching Item.DataString property is found, its zero-based index is returned, otherwise -1 is returned.